<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>IHibernateDaoSupport xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/katesoft/scale4j/persistent/client/IHibernateDaoSupport.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> com.katesoft.scale4j.persistent.client;
<a class="jxr_linenumber" name="2" href="#2">2</a>   
<a class="jxr_linenumber" name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> com.katesoft.scale4j.persistent.model.unified.AbstractPersistentEntity;
<a class="jxr_linenumber" name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> com.katesoft.scale4j.persistent.types.RevisionData;
<a class="jxr_linenumber" name="5" href="#5">5</a>   <strong class="jxr_keyword">import</strong> org.springframework.dao.DataAccessException;
<a class="jxr_linenumber" name="6" href="#6">6</a>   
<a class="jxr_linenumber" name="7" href="#7">7</a>   <strong class="jxr_keyword">import</strong> java.util.Collection;
<a class="jxr_linenumber" name="8" href="#8">8</a>   <strong class="jxr_keyword">import</strong> java.util.Date;
<a class="jxr_linenumber" name="9" href="#9">9</a>   <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="10" href="#10">10</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="11" href="#11">11</a>  
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * Convenient super class for Hibernate-based data access objects.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> * This base class is mainly intended for LocalHibernateTemplate usage.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * You can find method to work with historical data here and convenient method to perform lucene search operations on top of domain classes.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * @author kate2007</em>
<a class="jxr_linenumber" name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../com/katesoft/scale4j/persistent/client/IHibernateDaoSupport.html">IHibernateDaoSupport</a>
<a class="jxr_linenumber" name="22" href="#22">22</a>  {
<a class="jxr_linenumber" name="23" href="#23">23</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_javadoccomment">     * Searches for persistent entities of the given entityClass based on query string. &lt;p&gt; Note: This method must be used only if entity class is annotated</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_javadoccomment">     * with @Indexed annotation. &lt;p/&gt; Also this method can't cause {@link OutOfMemoryError} because restricts max result to pre-defined maximum size. &lt;p/&gt;</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  <em class="jxr_javadoccomment">     * Search is restricted by given properties. &lt;/p&gt;</em>
<a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment">     * @param &lt;T&gt;         type of entity.</em>
<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment">     * @param queryString search string or &lt;code&gt;NULL&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment">     * @param entityClass entity class.</em>
<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment">     * @param properties  search restriction fields.</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment">     * @return list of founded entities.</em>
<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment">     * @throws org.springframework.dao.DataAccessException</em>
<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment">     *          any jdbc exception.</em>
<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment">     * @see org.apache.lucene.search.Query</em>
<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="37" href="#37">37</a>      &lt;T <strong class="jxr_keyword">extends</strong> AbstractPersistentEntity&gt; List&lt;T&gt; search(<strong class="jxr_keyword">final</strong> String queryString,
<a class="jxr_linenumber" name="38" href="#38">38</a>                                                          <strong class="jxr_keyword">final</strong> Class&lt;T&gt; entityClass,
<a class="jxr_linenumber" name="39" href="#39">39</a>                                                          <strong class="jxr_keyword">final</strong> String[] properties) <strong class="jxr_keyword">throws</strong> DataAccessException;
<a class="jxr_linenumber" name="40" href="#40">40</a>  
<a class="jxr_linenumber" name="41" href="#41">41</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">     * looking for latest revision of entity. latest revision always exists unless there is no such entity(with given unique identifier).</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     * @param entityClass      domain class</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     * @param uniqueIdentifier domain entity unique identifier</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     * @param &lt;T&gt;              type of entity</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     * @return latest revision of entity.</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     * @throws org.springframework.dao.DataAccessException</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     *          any jdbc exception.</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>      &lt;T <strong class="jxr_keyword">extends</strong> AbstractPersistentEntity&gt; Number latestRevision(Class&lt;T&gt; entityClass,
<a class="jxr_linenumber" name="52" href="#52">52</a>                                                                 <strong class="jxr_keyword">long</strong> uniqueIdentifier) <strong class="jxr_keyword">throws</strong> DataAccessException;
<a class="jxr_linenumber" name="53" href="#53">53</a>  
<a class="jxr_linenumber" name="54" href="#54">54</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     * looking up for the all revisions of entity(result list is sorted by revision number in descending order).</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * @param entityClass      domain class</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     * @param uniqueIdentifier domain entity unique identifier</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     * @param &lt;T&gt;              type of entity</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * @return sorted collection of all revisions of entity.</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * @throws org.springframework.dao.DataAccessException</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     *          any jdbc exception.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>      &lt;T <strong class="jxr_keyword">extends</strong> AbstractPersistentEntity&gt; List&lt;Number&gt; allRevisions(Class&lt;T&gt; entityClass,
<a class="jxr_linenumber" name="65" href="#65">65</a>                                                                     <strong class="jxr_keyword">long</strong> uniqueIdentifier) <strong class="jxr_keyword">throws</strong> DataAccessException;
<a class="jxr_linenumber" name="66" href="#66">66</a>  
<a class="jxr_linenumber" name="67" href="#67">67</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="68" href="#68">68</a>  <em class="jxr_javadoccomment">     * retrieve revision data information of entity(all versions ordered by revision number desc).</em>
<a class="jxr_linenumber" name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     * @param entityClass      domain class</em>
<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     * @param uniqueIdentifier domain entity unique identifier</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * @param &lt;T&gt;              type of entity</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * @return sorted collection of all revision data information of entity.</em>
<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * @throws org.springframework.dao.DataAccessException</em>
<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     *          any jdbc exception.</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>      &lt;T <strong class="jxr_keyword">extends</strong> AbstractPersistentEntity&gt; List&lt;RevisionData&lt;T&gt;&gt; loadAllRevisions(Class&lt;T&gt; entityClass,
<a class="jxr_linenumber" name="78" href="#78">78</a>                                                                                  <strong class="jxr_keyword">long</strong> uniqueIdentifier) <strong class="jxr_keyword">throws</strong> DataAccessException;
<a class="jxr_linenumber" name="79" href="#79">79</a>  
<a class="jxr_linenumber" name="80" href="#80">80</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * looking entity's revision historical data by given date(maximum date less or equals given) - the most up to date revision will be picked.</em>
<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     * This method allows you to pass multiple primary keys and result will be map where keys are unique identifiers.</em>
<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * May be useful - result map is actually LinkedHashMap(so ordered according to unique identifiers collection).</em>
<a class="jxr_linenumber" name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     * Also please note that in case when no revision data found for particular identified, nothing will be added to result map.</em>
<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     * @param entityClass       domain class</em>
<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * @param date              historical data date</em>
<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     * @param uniqueIdentifiers collection of unique identifiers</em>
<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * @param property          date property to be used(if not specified revision timestamp will be used)</em>
<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * @param &lt;T&gt;               type of entity</em>
<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     * @return map where key is unique identifier and value is revision data</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * @throws org.springframework.dao.DataAccessException</em>
<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     *          any jdbc exception.</em>
<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="98" href="#98">98</a>      &lt;T <strong class="jxr_keyword">extends</strong> AbstractPersistentEntity&gt; Map&lt;Long, RevisionData&lt;T&gt;&gt; latestRevisionForDate(Class&lt;T&gt; entityClass,
<a class="jxr_linenumber" name="99" href="#99">99</a>                                                                                            Date date,
<a class="jxr_linenumber" name="100" href="#100">100</a>                                                                                           Collection&lt;Long&gt; uniqueIdentifiers,
<a class="jxr_linenumber" name="101" href="#101">101</a>                                                                                           String property) <strong class="jxr_keyword">throws</strong> DataAccessException;
<a class="jxr_linenumber" name="102" href="#102">102</a> 
<a class="jxr_linenumber" name="103" href="#103">103</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">     * looking entity's revision historical data by given date(maximum date less or equals given) - the most up to date revision will be picked.</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">     * @param entityClass      domain class</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment">     * @param date             historical data date</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * @param uniqueIdentifier primary key of entity</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * @param property         date property to be used(if not specified revision timestamp will be used)</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * @param &lt;T&gt;              type of entity</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * @return revision data for unique identifier or &lt;code&gt;NULL&lt;/code&gt; if nothing found.</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * @throws org.springframework.dao.DataAccessException</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment">     *          any jdbc exception.</em>
<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="115" href="#115">115</a>     &lt;T <strong class="jxr_keyword">extends</strong> AbstractPersistentEntity&gt; RevisionData&lt;T&gt; latestRevisionForDate(Class&lt;T&gt; entityClass,
<a class="jxr_linenumber" name="116" href="#116">116</a>                                                                                Date date,
<a class="jxr_linenumber" name="117" href="#117">117</a>                                                                                <strong class="jxr_keyword">long</strong> uniqueIdentifier,
<a class="jxr_linenumber" name="118" href="#118">118</a>                                                                                String property) <strong class="jxr_keyword">throws</strong> DataAccessException;
<a class="jxr_linenumber" name="119" href="#119">119</a>     <a href="../../../../../com/katesoft/scale4j/persistent/client/IHibernateOperations.html">IHibernateOperations</a> getLocalHibernateTemplate();
<a class="jxr_linenumber" name="120" href="#120">120</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

